com.inscoper.api.DeviceConfig

DeviceConfig class provides information for device configuration. More...

Public Functions

	Name
synchronized void	delete()
	DeviceConfig(EDriverType driverType) Constructor.
void	fromXML(XMLNode deviceNode) Load from XML.
void	toXML(XMLNode xmlParent) Save to XML.
String	getId() Get the ID of the device.
void	setId(String id) Set the ID of the device.
String	getMetaDeviceId() Get the meta device ID.
void	setMetaDeviceId(String metaDeviceId) Set the meta device ID.
EDriverType	getDriverType() Get the driver type of the device.
void	setDriverType(EDriverType driverType) Set the driver type of the device.
com.inscoper.nbo.ENBOType	getNBOType() Get the NBO type of the device.
boolean	hasNBOType() Check if the NBO type of the device is set.
void	setNBOType(com.inscoper.nbo.ENBOType nboType) Set the NBO type of the device.
void	unsetNBOType() Unset the NBO type of the device.
SubDeviceGroupConfigVector	getSubDeviceGroupConfigList() Get the sub-device group configuration list.
void	setSubDeviceGroupConfigList(SubDeviceGroupConfigVector subDeviceGroups) Set the sub-device group configuration list.
void	addSubDeviceGroupConfig(SubDeviceGroupConfig subDeviceGroup) Add a sub-device group configuration to the list.
DriverConfig	getDriverConfig() Get the driver configuration.
void	setDriverConfig(DriverConfig driverConfig) Set the driver configuration.

Protected Functions

	Name
	DeviceConfig(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(DeviceConfig obj)

Detailed Description

public class com.inscoper.api.DeviceConfig;

DeviceConfig class provides information for device configuration.

This class holds the configuration parameters for a specific device, including its ID, driver type, sub-device groups, and driver-specific settings.

Public Functions Documentation

function delete

public synchronized void delete()

function DeviceConfig

public DeviceConfig(
    EDriverType driverType
)

Constructor.

Parameters:

• driverType : The driver type of the device

Initializes a new instance of DeviceConfig with the specified driver type.

function fromXML

public void fromXML(
    XMLNode deviceNode
)

Load from XML.

Parameters:

• deviceNode : The XML node containing device information

Exceptions:

• InscoperException If an error occurs

Populates the device configuration from the provided XML node.

function toXML

public void toXML(
    XMLNode xmlParent
)

Save to XML.

Parameters:

• xmlParent : The parent XML node

Exceptions:

• InscoperException If an error occurs

Serializes the device configuration to the specified parent XML node.

function getId

public String getId()

Get the ID of the device.

Return: The ID of the device

Retrieves the unique identifier of the device.

function setId

public void setId(
    String id
)

Set the ID of the device.

Parameters:

• id : The ID of the device

Assigns a unique identifier to the device.

function getMetaDeviceId

public String getMetaDeviceId()

Get the meta device ID.

Return: The meta device ID

Retrieves the meta device ID this device belongs to. Empty string if the device is standalone.

function setMetaDeviceId

public void setMetaDeviceId(
    String metaDeviceId
)

Set the meta device ID.

Parameters:

• metaDeviceId : The meta device ID

Assigns the meta device ID this device belongs to. Set to empty string for standalone devices.

function getDriverType

public EDriverType getDriverType()

Get the driver type of the device.

Return: The driver type of the device

Retrieves the type of driver associated with this device.

function setDriverType

public void setDriverType(
    EDriverType driverType
)

Set the driver type of the device.

Parameters:

• driverType : The driver type of the device

Sets the type of driver for this device.

function getNBOType

public com.inscoper.nbo.ENBOType getNBOType()

Get the NBO type of the device.

Return: The NBO type of the device

Retrieves the NBO type of the device.

function hasNBOType

public boolean hasNBOType()

Check if the NBO type of the device is set.

Return: True if the NBO type is set, false otherwise

Checks whether an NBO type has been explicitly defined for this device.

function setNBOType

public void setNBOType(
    com.inscoper.nbo.ENBOType nboType
)

Set the NBO type of the device.

Parameters:

• nboType : The NBO type of the device

Sets the NBO type of the device.

function unsetNBOType

public void unsetNBOType()

Unset the NBO type of the device.

Removes the NBO type definition, making hasNBOType() return false.

function getSubDeviceGroupConfigList

public SubDeviceGroupConfigVector getSubDeviceGroupConfigList()

Get the sub-device group configuration list.

Return: The list of sub-device group configurations

Retrieves the list of sub-device group configurations associated with this device.

function setSubDeviceGroupConfigList

public void setSubDeviceGroupConfigList(
    SubDeviceGroupConfigVector subDeviceGroups
)

Set the sub-device group configuration list.

Parameters:

• subDeviceGroups : The list of sub-device group configurations

Replaces the current list of sub-device group configurations.

function addSubDeviceGroupConfig

public void addSubDeviceGroupConfig(
    SubDeviceGroupConfig subDeviceGroup
)

Add a sub-device group configuration to the list.

Parameters:

• subDeviceGroup : The sub-device group configuration to add

Appends a new sub-device group configuration to the device.

function getDriverConfig

public DriverConfig getDriverConfig()

Get the driver configuration.

Return: The driver configuration

Retrieves the specific configuration for the underlying driver.

function setDriverConfig

public void setDriverConfig(
    DriverConfig driverConfig
)

Set the driver configuration.

Parameters:

• driverConfig : The driver configuration

Assigns the specific configuration for the underlying driver.

Protected Functions Documentation

function DeviceConfig

protected DeviceConfig(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

function finalize

protected void finalize()

function getCPtr

protected static long getCPtr(
    DeviceConfig obj
)

---

Updated on 2026-06-23 at 10:35:24 +0200